ltecat17 2.2.3
Loading...
Searching...
No Matches
ltecat17.h
Go to the documentation of this file.
1/****************************************************************************
2** Copyright (C) 2026 MikroElektronika d.o.o.
3** Contact: https://www.mikroe.com/contact
4**
5** Permission is hereby granted, free of charge, to any person obtaining a copy
6** of this software and associated documentation files (the "Software"), to deal
7** in the Software without restriction, including without limitation the rights
8** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9** copies of the Software, and to permit persons to whom the Software is
10** furnished to do so, subject to the following conditions:
11** The above copyright notice and this permission notice shall be
12** included in all copies or substantial portions of the Software.
13**
14** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20** USE OR OTHER DEALINGS IN THE SOFTWARE.
21****************************************************************************/
22
27
28#ifndef LTECAT17_H
29#define LTECAT17_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
39#ifdef PREINIT_SUPPORTED
40#include "preinit.h"
41#endif
42
43#ifdef MikroCCoreVersion
44 #if MikroCCoreVersion >= 1
45 #include "delays.h"
46 #endif
47#endif
48
49#include "drv_digital_out.h"
50#include "drv_digital_in.h"
51#include "drv_uart.h"
52
58
63
68
73#define LTECAT17_CMD_AT "AT"
74#define LTECAT17_CMD_GET_MODEL_ID "AT+CGMM"
75#define LTECAT17_CMD_GET_SW_VERSION "AT+CGMR"
76#define LTECAT17_CMD_GET_SERIAL_NUM "AT+CGSN"
77#define LTECAT17_CMD_FACTORY_RESET "AT&F"
78#define LTECAT17_CMD_SET_PHONE_FUNCTIONALITY "AT+CFUN"
79#define LTECAT17_CMD_NETWORK_REGISTRATION "AT+CEREG"
80#define LTECAT17_CMD_SIGNAL_QUALITY_REPORT "AT+CSQ"
81#define LTECAT17_CMD_OPERATOR_SELECTION "AT+COPS"
82#define LTECAT17_CMD_SEND_SMS "AT+CMGS"
83#define LTECAT17_CMD_SELECT_SMS_FORMAT "AT+CMGF"
84#define LTECAT17_CMD_DEFINE_PDP_CONTEXT "AT+CGDCONT"
85#define LTECAT17_CMD_ACTIVATE_PDP_CONTEXT "AT+CGACT"
86#define LTECAT17_CMD_SHOW_PDP_ADDRESS "AT+CGPADDR"
87#define LTECAT17_CMD_START_TCPIP_SERVICE "AT+NETOPEN"
88#define LTECAT17_CMD_OPEN_TCP_UDP_CONNECTION "AT+CIPOPEN"
89#define LTECAT17_CMD_SEND_DATA_VIA_CONNECTION "AT+CIPSEND"
90#define LTECAT17_CMD_RECEIVE_DATA_VIA_CONNECTION "AT+CIPRXGET"
91#define LTECAT17_CMD_CLOSE_TCP_UDP_CONNECTION "AT+CIPCLOSE"
92#define LTECAT17_CMD_GNSS_POWER_CONTROL "AT+CGNSSPWR"
93#define LTECAT17_CMD_GET_GNSS_INFO "AT+CGNSSINFO"
94
99#define LTECAT17_RSP_OK "OK"
100#define LTECAT17_RSP_ERROR "ERROR"
101
106#define LTECAT17_URC_RECEIVED_DATA "+CIPRXGET:"
107
112#define LTECAT17_POWER_STATE_OFF 0
113#define LTECAT17_POWER_STATE_ON 1
114
120#define LTECAT17_TX_DRV_BUFFER_SIZE 256
121#define LTECAT17_RX_DRV_BUFFER_SIZE 256
122 // ltecat17_cmd
124
129
134
139#define LTECAT17_MAP_MIKROBUS( cfg, mikrobus ) \
140 cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
141 cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
142 cfg.pwr = MIKROBUS( mikrobus, MIKROBUS_AN ); \
143 cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
144 cfg.ring = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
145 cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT );
146 // ltecat17_map // ltecat17
149
154typedef struct
155{
156 // Output pins
157 digital_out_t pwr;
158 digital_out_t rts;
159
160 // Input pins
161 digital_in_t ring;
162 digital_in_t cts;
163
164 // Modules
165 uart_t uart;
166
167 // Buffers
171
172} ltecat17_t;
173
178typedef struct
179{
180 // Communication gpio pins
181 pin_name_t rx_pin;
182 pin_name_t tx_pin;
183
184 // Additional gpio pins
185 pin_name_t pwr;
186 pin_name_t rts;
187 pin_name_t ring;
188 pin_name_t cts;
189
190 // Static variable
191 uint32_t baud_rate;
193 uart_data_bits_t data_bit;
194 uart_parity_t parity_bit;
195 uart_stop_bits_t stop_bit;
196
198
211
217
228
243
256err_t ltecat17_generic_write ( ltecat17_t *ctx, uint8_t *data_in, uint16_t len );
257
270err_t ltecat17_generic_read ( ltecat17_t *ctx, uint8_t *data_out, uint16_t len );
271
281void ltecat17_set_pwr_pin ( ltecat17_t *ctx, uint8_t state );
282
292void ltecat17_set_rts_pin ( ltecat17_t *ctx, uint8_t state );
293
303
313
324void ltecat17_set_power_state ( ltecat17_t *ctx, uint8_t state );
325
335void ltecat17_cmd_run ( ltecat17_t *ctx, uint8_t *cmd );
336
347void ltecat17_cmd_set ( ltecat17_t *ctx, uint8_t *cmd, uint8_t *value );
348
358void ltecat17_cmd_get ( ltecat17_t *ctx, uint8_t *cmd );
359
369void ltecat17_cmd_help ( ltecat17_t *ctx, uint8_t *cmd );
370
380void ltecat17_set_sim_apn ( ltecat17_t *ctx, uint8_t *sim_apn );
381
392void ltecat17_send_sms_text ( ltecat17_t *ctx, uint8_t *phone_number, uint8_t *sms_text );
393
407err_t ltecat17_send_sms_pdu ( ltecat17_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text );
408
409#ifdef __cplusplus
410}
411#endif
412#endif // LTECAT17_H
413 // ltecat17
415
416// ------------------------------------------------------------------------ END
#define LTECAT17_RX_DRV_BUFFER_SIZE
Definition ltecat17.h:121
#define LTECAT17_TX_DRV_BUFFER_SIZE
LTE Cat.1 7 driver buffer size.
Definition ltecat17.h:120
err_t ltecat17_init(ltecat17_t *ctx, ltecat17_cfg_t *cfg)
LTE Cat.1 7 initialization function.
void ltecat17_set_sim_apn(ltecat17_t *ctx, uint8_t *sim_apn)
Set sim card APN.
void ltecat17_cfg_setup(ltecat17_cfg_t *cfg)
LTE Cat.1 7 configuration object setup function.
void ltecat17_set_power_state(ltecat17_t *ctx, uint8_t state)
LTE Cat.1 7 set power state function.
uint8_t ltecat17_get_cts_pin(ltecat17_t *ctx)
LTE Cat.1 7 get CTS pin function.
void ltecat17_send_sms_text(ltecat17_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
LTE Cat.1 7 send SMS in text mode.
err_t ltecat17_generic_write(ltecat17_t *ctx, uint8_t *data_in, uint16_t len)
LTE Cat.1 7 data writing function.
void ltecat17_cmd_run(ltecat17_t *ctx, uint8_t *cmd)
LTE Cat.1 7 cmd run function.
void ltecat17_cmd_get(ltecat17_t *ctx, uint8_t *cmd)
LTE Cat.1 7 cmd get function.
void ltecat17_cmd_set(ltecat17_t *ctx, uint8_t *cmd, uint8_t *value)
LTE Cat.1 7 cmd set function.
err_t ltecat17_send_sms_pdu(ltecat17_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text)
LTE Cat.1 7 send SMS in PDU mode.
err_t ltecat17_generic_read(ltecat17_t *ctx, uint8_t *data_out, uint16_t len)
LTE Cat.1 7 data reading function.
void ltecat17_cmd_help(ltecat17_t *ctx, uint8_t *cmd)
LTE Cat.1 7 cmd help function.
void ltecat17_set_rts_pin(ltecat17_t *ctx, uint8_t state)
LTE Cat.1 7 set RTS pin function.
uint8_t ltecat17_get_ring_pin(ltecat17_t *ctx)
LTE Cat.1 7 get RING pin function.
void ltecat17_set_pwr_pin(ltecat17_t *ctx, uint8_t state)
LTE Cat.1 7 set PWR pin function.
ltecat17_return_value_t
LTE Cat.1 7 Click return value data.
Definition ltecat17.h:204
@ LTECAT17_ERROR
Definition ltecat17.h:206
@ LTECAT17_ERROR_CMD
Definition ltecat17.h:208
@ LTECAT17_ERROR_TIMEOUT
Definition ltecat17.h:207
@ LTECAT17_OK
Definition ltecat17.h:205
LTE Cat.1 7 Click configuration object.
Definition ltecat17.h:179
pin_name_t rts
Definition ltecat17.h:186
uint32_t baud_rate
Definition ltecat17.h:191
pin_name_t cts
Definition ltecat17.h:188
pin_name_t ring
Definition ltecat17.h:187
bool uart_blocking
Definition ltecat17.h:192
uart_data_bits_t data_bit
Definition ltecat17.h:193
pin_name_t tx_pin
Definition ltecat17.h:182
pin_name_t pwr
Definition ltecat17.h:185
pin_name_t rx_pin
Definition ltecat17.h:181
uart_stop_bits_t stop_bit
Definition ltecat17.h:195
uart_parity_t parity_bit
Definition ltecat17.h:194
LTE Cat.1 7 Click context object.
Definition ltecat17.h:155
uint8_t cmd_buffer[LTECAT17_TX_DRV_BUFFER_SIZE]
Definition ltecat17.h:170
digital_out_t pwr
Definition ltecat17.h:157
digital_out_t rts
Definition ltecat17.h:158
uart_t uart
Definition ltecat17.h:165
digital_in_t cts
Definition ltecat17.h:162
uint8_t uart_tx_buffer[LTECAT17_TX_DRV_BUFFER_SIZE]
Definition ltecat17.h:169
uint8_t uart_rx_buffer[LTECAT17_RX_DRV_BUFFER_SIZE]
Definition ltecat17.h:168
digital_in_t ring
Definition ltecat17.h:161